/*!	 target_tile.h
**	 Template Header
**
**	Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
**	Copyright (c) 2008 Chris Moore
**	Copyright (c) 2012-2013 Carlos López
**
**	This package is free software; you can redistribute it and/or
**	modify it under the terms of the GNU General Public License as
**	published by the Free Software Foundation; either version 2 of
**	the License, or (at your option) any later version.
**
**	This package is distributed in the hope that it will be useful,
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
**	General Public License for more details.
**
*/

#ifndef __SYNFIG_TARGET_TILE_H
#define __SYNFIG_TARGET_TILE_H

#include "target.h"

#define TILE_SIZE 64

namespace synfig
{

namespace rendering
{
class SurfaceSW;
}

/*!	\class Target_Tile
**	 Render-target
**	TODO:  writeme
*/
class Target_Tile : public Target
{
    // Number of threads
    int threads_;
    // Tile width in pixels
    int tile_w_;
    // Tile height in pixles
    int tile_h_;
    // The current tile being rendered
    int curr_tile_;
    // Determines if the tiles should be clipped to the redener description
    // or not
    bool clipping_;

    bool allow_multithreading_;

    String engine_;

    struct TileGroup;

    bool call_renderer(Context &context, const etl::handle<rendering::SurfaceSW> &surfacesw, int quality, const RendDesc &renddesc, ProgressCallback *cb);

public:
    typedef etl::handle<Target_Tile> Handle;
    typedef etl::loose_handle<Target_Tile> LooseHandle;
    typedef etl::handle<const Target_Tile> ConstHandle;

    Target_Tile();

    // Renders the canvas to the target
    virtual bool render(ProgressCallback *cb = NULL);

    virtual bool async_render_tile(RectInt rect, Context context, RendDesc tile_desc, ProgressCallback *cb = NULL);
    virtual bool wait_render_tiles(ProgressCallback *cb = NULL);

    // Determines which tile needs to be rendered next.
    /*!	Most cases will not have to redefine this function.
    **	The default should be adequate in nearly all situations.
    **	\returns The number of tiles left to go <i>plus one</i>.
    **		This means that whenever this function returns zero,
    **		there are no more tiles to render and that any value
    **		in \a rect should be disregarded. */
    virtual int next_tile(RectInt& rect);

    // Returns the number of peniding frames to render. If it is zero it
    // stops rendering frames.
    virtual int next_frame(Time& time);

    // Adds the tile at \a x , \a y contained in \a surface
    virtual bool add_tile(const synfig::Surface &surface, int x, int y) = 0;

    // Marks the start of a frame
    /*! \return \c true on success, \c false upon an error.
    **	\see end_frame(), start_scanline()
    */
    virtual bool start_frame(ProgressCallback *cb = NULL) = 0;

    // Marks the end of a frame
    /*! \see start_frame() */
    virtual void end_frame() = 0;
    // Sets the number of threads
    void set_threads(int x)
    {
        threads_ = x;
    }
    // Gets the number of threads
    int get_threads()const
    {
        return threads_;
    }
    // Sets the tile widht
    void set_tile_w(int w)
    {
        tile_w_ = w;
    }
    // Gets the tile widht
    int get_tile_w()const
    {
        return tile_w_;
    }
    // Sets the tile height
    void set_tile_h(int h)
    {
        tile_h_ = h;
    }
    // Gets the tile height
    int get_tile_h()const
    {
        return tile_h_;
    }
    // Gets clipping
    bool get_clipping()const
    {
        return clipping_;
    }
    // Sets clipping
    void set_clipping(bool x)
    {
        clipping_ = x;
    }
    // Gets clipping
    bool get_allow_multithreading()const
    {
        return allow_multithreading_;
    }
    // Sets clipping
    void set_allow_multithreading(bool x)
    {
        allow_multithreading_ = x;
    }
    // Gets engine
    const String& get_engine()const
    {
        return engine_;
    }
    // Sets engine
    void set_engine(const String &x)
    {
        engine_ = x;
    }

private:
    // Renders the context to the surface
    bool render_frame_(Context context, ProgressCallback *cb = 0);

}; // END of class Target_Tile

}; // END of namespace synfig

#endif